/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the examples of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef ARROW_H
#define ARROW_H

#include <QGraphicsLineItem>

#include "diagramitem.hpp"

QT_BEGIN_NAMESPACE
class QGraphicsPolygonItem;
class QGraphicsLineItem;
class QGraphicsScene;
class QRectF;
class QGraphicsSceneMouseEvent;
class QPainterPath;
QT_END_NAMESPACE

/**
* @brief
*
* @class Arrow arrow.hpp "arrow.hpp"
*/
class Arrow : public QGraphicsLineItem
{
public:
    enum { Type = UserType + 4 };

    /**
    * @brief Arrow Constructor
    *
    * @fn Arrow(DiagramItem *startItem, DiagramItem *endItem, QGraphicsItem *parent = 0, QGraphicsScene *scene = 0)
    * @param startItem
    * @param endItem
    * @param parent
    * @param scene
    */
    Arrow(DiagramItem *startItem, DiagramItem *endItem, QGraphicsItem *parent = 0, QGraphicsScene *scene = 0);

    /**
    * @brief Returns the type of the arrow
    *
    * @fn int type() const
    */
    int type() const
        { return Type; }

    /**
    * @brief Returns the boundingRect of the arrow
    *
    * @fn QRectF boundingRect() const
    * @return QRectF
    */
    QRectF boundingRect() const;

    /**
    * @brief Returns the shape of the arrow
    *
    * @fn QPainterPath shape() const
    * @return QPainterPath
    */
    QPainterPath shape() const;

    /**
    * @brief Sets the color of the arrow
    *
    * @fn void setColor(const QColor &color)
    */
    void setColor(const QColor &color)
        { myColor = color; }

    /**
    * @brief Returns the startitem of the arrow
    *
    * @fn DiagramItem *startItem() const
    * @return DiagramItem
    */
    DiagramItem *startItem() const
        { return myStartItem; }

    /**
    * @brief Returns the enditem of the arrow
    *
    * @fn DiagramItem *endItem() const
    * @return DiagramItem
    */
    DiagramItem *endItem() const
        { return myEndItem; }

    /**
    * @brief Checks if 2 arrows are equal
    *
    * @fn bool equal(Arrow *arrow)
    * @param arrow
    * @return bool
    */
    bool equal(Arrow *arrow);


public slots:
    void updatePosition();

protected:
    void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);

private:
    DiagramItem *myStartItem;
    DiagramItem *myEndItem;
    QColor myColor;
    QPolygonF arrowHead;
};

#endif
